package com.forum.module.system.service.auth;

import com.forum.module.system.controller.admin.auth.vo.AuthLoginReqVO;
import com.forum.module.system.controller.admin.auth.vo.AuthLoginRespVO;
import com.forum.module.system.controller.admin.auth.vo.AuthRegisterReqVO;
import com.forum.module.system.controller.admin.auth.vo.AuthRegisterRespVO;
import com.forum.module.system.dal.dataobject.user.UserDO;
import jakarta.validation.Valid;

/**
 * 管理后台的认证 Service 接口
 * 提供用户的登录、登出的能力
 *
 * @author zihan.ouyang
 */
public interface AdminAuthService {
    /**
     * 验证账号 + 密码。如果通过，则返回用户
     *
     * @param username 账号
     * @param password 密码
     * @return 用户
     */
    UserDO authenticate(String username, String password);

    /**
     * 账号登录
     *
     * @param reqVO 登录信息
     * @return 登录结果
     */
    AuthLoginRespVO login(@Valid AuthLoginReqVO reqVO);

    /**
     * 刷新 token
     *
     * @param refreshToken 刷新 token
     * @return 新的 token
     */
    AuthLoginRespVO refreshToken(String refreshToken);

    /**
     * 注册用户
     *
     * @param reqVO 注册信息
     * @return 注册结果
     */
    AuthRegisterRespVO register(@Valid AuthRegisterReqVO reqVO);

    /**
     * 登出用户
     *
     * @param token 权限
     */
    void logout(String token);
}
